package com.sxran.im.core.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 实体表描述注解
 * <li>目标：实体类</li>
 * <li>用途：用于给每个实体类设置一些信息，如中文名称，这样在出现异常时可以利用该信息给出更友好的提示</li>
 * <li>例如：给 User 类备注的中文描述是“用户”，查询异常时可向前端提示：用户（ID：xxx）不存在</li>
 *
 * @author Jastar Wang
 * @date 2023/7/18
 * @since 3.8.0
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TableDesc {
    /**
     * 实体类对应的中文名称
     *
     * @return 中文/模块名称
     */
    String value();
}
